docs: add docstrings to undocumented functions in utils.py#1399
Open
mastash3ff wants to merge 1 commit into
Open
docs: add docstrings to undocumented functions in utils.py#1399mastash3ff wants to merge 1 commit into
mastash3ff wants to merge 1 commit into
Conversation
Add module-level docstrings to Fragment, mimetype_from_string, mimetype_from_path, dicts_to_table_string, make_schema_id, resolve_schema_input, ensure_fragment, and ensure_tool. No logic or behaviour changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Several utility functions in
llm/utils.pywere missing docstrings, making it harder to understand their purpose when reading the source or generated API docs.This PR adds docstrings to eight previously undocumented public symbols, matching the existing one-liner or short-paragraph style already used in the file:
Fragment— class-level docstring explaining the source-attribution rolemimetype_from_string/mimetype_from_path— describe magic-byte detection and None returndicts_to_table_string— describe column-justified plain-text table outputmake_schema_id— describe the BLAKE2b hash and return tupleresolve_schema_input— enumerate the four accepted input formatsensure_fragment/ensure_tool— describe upsert semantics and returned idNo logic, behaviour, or tests are changed.